<html>
   <head>
      <link rel="stylesheet" type="text/css" href="style.css" />
   </head>
   <body onload="">
<h2 class="comptitle">Simple Module <i>Vast</i></h2>
<b>Package:</b> oversim.overlay.vast<br/><b>File: <a href="src-overlay-vast-Vast.ned.html">src/overlay/vast/Vast.ned</a></b><br/><p><a href="../doxy/classBaseOverlay.html" target="mainframe"><b>C++ definition</b></a></p>
<p>(no description)</p><img src="oversim.overlay.vast.Vast-type.png" ismap="yes" usemap="#type-diagram"/><map name="type-diagram">
<area shape="rect" href="oversim.overlay.vast.Vast.html" title="Vast" alt="Vast" coords="0,0,69,40">
</map>
<h3 class="subtitle">Usage diagram:</h3>
<p>The following diagram shows usage relationships between types.
Unresolved types are missing from the diagram.
Click <a href="full-ned-usage-diagram.html">here</a> to see the full picture.</p>
<img src="oversim.overlay.vast.Vast-usage.png" ismap="yes" usemap="#usage-diagram"/><map name="usage-diagram"><area shape="rect" id="node1" href="oversim.overlay.vast.Vast.html" title="Simple Module Vast" alt="" coords="16,83,88,111">
<area shape="rect" id="node2" href="oversim.overlay.vast.OverlayVast.html" title="Compound Module OverlayVast" alt="" coords="5,6,99,34">
</map>
<h3 class="subtitle">Inheritance diagram:</h3>
<p>The following diagram shows inheritance relationships for this type.
Unresolved types are missing from the diagram.
Click <a href="full-ned-inheritance-diagram.html">here</a> to see the full picture.</p>
<img src="oversim.overlay.vast.Vast-inheritance.png" ismap="yes" usemap="#inheritance-diagram"/><map name="inheritance-diagram"><area shape="rect" id="node1" href="oversim.overlay.vast.Vast.html" title="Simple Module Vast" alt="" coords="17,83,89,111">
<area shape="rect" id="node2" href="oversim.common.BaseOverlay.html" title="Simple Module BaseOverlay" alt="" coords="5,6,101,34">
</map>
<h3 class="subtitle">Extends:</h3>
<table>
<tr>
   <td>
      <a href="oversim.common.BaseOverlay.html">BaseOverlay</a>
      <i> (simple&nbsp;module)</i>
   </td>
   <td>

<p>Base class for overlay implementations</p>
   </td>
</tr>
</table>
<h3 class="subtitle">Used in compound modules:</h3>
<p>If a module type shows up more than once, that means it has been defined in more than one NED file.</p>
<table>
<tr>
   <td>
      <a href="oversim.overlay.vast.OverlayVast.html">OverlayVast</a>
      <i> (compound&nbsp;module)</i>
   </td>
   <td>
<i>(no description)</i>
   </td>
</tr>
</table>
<h3 class="subtitle">Parameters:</h3>
<table class="paramtable">
   <tr>
      <th>Name</th>
      <th>Type</th>
      <th>Default value</th>
      <th>Description</th>
   </tr>
<tr class="inherited">
   <td width="150">rpcUdpTimeout</td>
   <td width="100">
      <i>double</i>
   </td>
   <td width="120"></td>
   <td>
<p>default timeout value for direct RPCs</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">rpcKeyTimeout</td>
   <td width="100">
      <i>double</i>
   </td>
   <td width="120"></td>
   <td>
<p>default timeout value for routed RPCs</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">optimizeTimeouts</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>calculate timeouts from measured RTTs
and network coordinates</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">rpcExponentialBackoff</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>if true, doubles the timeout for
every retransmission</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">localPort</td>
   <td width="100">
      <i>int</i>
   </td>
   <td width="120"></td>
   <td>
<p>UDP port for overlay messages</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">debugOutput</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>enable debug output</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">keyLength</td>
   <td width="100">
      <i>int</i>
   </td>
   <td width="120"></td>
   <td>
<p>overlay key length in bits</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">nodeId</td>
   <td width="100">
      <i>string</i>
   </td>
   <td width="120"></td>
   <td>
<p>optional nodeId as string in hexadecimal notation</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">useCommonAPIforward</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>enable CommonAPI forward() calls</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">drawOverlayTopology</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>draw arrow to successor node?</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">hopCountMax</td>
   <td width="100">
      <i>int</i>
   </td>
   <td width="120"></td>
   <td>
<p>maximum number of overlay hops</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">recNumRedundantNodes</td>
   <td width="100">
      <i>int</i>
   </td>
   <td width="120"></td>
   <td>
<p>numRedundantNodes for recursive routing</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">joinOnApplicationRequest</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>only join the overlay on application request</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">collectPerHopDelay</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>delay statistics for single hops</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">routeMsgAcks</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>use RPCs for route messages</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">lookupRedundantNodes</td>
   <td width="100">
      <i>int</i>
   </td>
   <td width="120"></td>
   <td>
<p>number of next hops in each step</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">lookupParallelPaths</td>
   <td width="100">
      <i>int</i>
   </td>
   <td width="120"></td>
   <td>
<p>number of parallel paths</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">lookupParallelRpcs</td>
   <td width="100">
      <i>int</i>
   </td>
   <td width="120"></td>
   <td>
<p>number of nodes to ask in parallel</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">lookupVerifySiblings</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>true, if siblings need to be authenticated with a ping</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">lookupMajoritySiblings</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>true, if sibling candidates are selected by a majority decision if using parallel paths</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">lookupMerge</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>true, if parallel Rpc results should be merged</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">lookupFailedNodeRpcs</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>communicate failed nodes</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">lookupStrictParallelRpcs</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>limited the number of concurrent rpcs to parameter parallelRpcs</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">lookupUseAllParallelResponses</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>merge all parallel responses from earlier steps</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">lookupNewRpcOnEveryTimeout</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>send a new RPC immediately after an RPC timeouts</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">lookupNewRpcOnEveryResponse</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>send a new RPC after every response, even if there was no progress</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">lookupFinishOnFirstUnchanged</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>finish lookup, if the last pending RPC returned without progress</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">lookupVisitOnlyOnce</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>if true, the same node is never asked twice during a single lookup</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">lookupAcceptLateSiblings</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>if true, a <a href="FindNodeResponse.html">FindNodeResponse</a> with sibling flag set is always accepted, even if it is from a previous lookup step</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">routingType</td>
   <td width="100">
      <i>string</i>
   </td>
   <td width="120"></td>
   <td>
<p>default routing mode (iterative, semi-recursive,...)</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">rejoinOnFailure</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>rejoin after loosing connection to the overlay?</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">sendRpcResponseToLastHop</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>needed by KBR protocols for NAT support</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">recordRoute</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>record visited hops on route</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">dropFindNodeAttack</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>if node is malicious, it tries a findNode attack</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">isSiblingAttack</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>if node is malicious, it tries a isSibling attack</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">invalidNodesAttack</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>if node is malicious, it tries a invalidNode attack</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">dropRouteMessageAttack</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>if node is malicious, it drops all received BaseRouteMessages</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">measureAuthBlock</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>if true, measure the overhead of signatures in rpc messages</p>
   </td>
</tr>
<tr class="inherited">
   <td width="150">restoreContext</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>if true, a node rejoins with its old nodeId and malicious state</p>
   </td>
</tr>
<tr class="local">
   <td width="150">areaDimension</td>
   <td width="100">
      <i>double</i>
   </td>
   <td width="120"></td>
   <td>
<p>movement range from [0.0, 0.0] to [areaDimension, areaDimension]</p>
   </td>
</tr>
<tr class="local">
   <td width="150">debugVastOutput</td>
   <td width="100">
      <i>bool</i>
   </td>
   <td width="120"></td>
   <td>
<p>enable voronoi diagram debug information</p>
   </td>
</tr>
<tr class="local">
   <td width="150">AOIWidth</td>
   <td width="100">
      <i>double</i>
   </td>
   <td width="120"></td>
   <td>
<p>this nodes area of interest</p>
   </td>
</tr>
<tr class="local">
   <td width="150">stockListSize</td>
   <td width="100">
      <i>double</i>
   </td>
   <td width="120"></td>
   <td>
<p>size of the stockList</p>
   </td>
</tr>
<tr class="local">
   <td width="150">joinTimeout</td>
   <td width="100">
      <i>double</i>
   </td>
   <td width="120"></td>
   <td>
<p>retry join timeout in seconds</p>
   </td>
</tr>
<tr class="local">
   <td width="150">pingTimeout</td>
   <td width="100">
      <i>double</i>
   </td>
   <td width="120"></td>
   <td>
<p>ping neighbor status in seconds</p>
   </td>
</tr>
<tr class="local">
   <td width="150">discoveryIntervall</td>
   <td width="100">
      <i>double</i>
   </td>
   <td width="120"></td>
   <td>
<p>asks stock neighbors for their neighborslist</p>
   </td>
</tr>
<tr class="local">
   <td width="150">criticalCheckIntervall</td>
   <td width="100">
      <i>double</i>
   </td>
   <td width="120"></td>
   <td>
<p>checks intervall for NeighborLevel for preventing partitions</p>
   </td>
</tr>
<tr class="local">
   <td width="150">criticalThreshold</td>
   <td width="100">
      <i>double</i>
   </td>
   <td width="120"></td>
   <td>
<p>threshold to activate backup operation</p>
   </td>
</tr>
</table>
<h3 class="subtitle">Properties:</h3>
<table class="paramtable">
   <tr>
      <th>Name</th>
      <th>Value</th>
      <th>Description</th>
   </tr>
<tr>
   <td width="150">class</td>
   <td width="100"><i>Vast</i></td>
   <td></td>
</tr>
<tr>
   <td width="150">display</td>
   <td width="100"><i>i=block/circle</i></td>
   <td></td>
</tr>
</table>
<h3 class="subtitle">Gates:</h3>
<table class="paramtable">
   <tr>
      <th>Name</th>
      <th>Direction</th>
      <th>Size</th>
      <th>Description</th>
   </tr>
<tr class="inherited">
   <td width="150">udpIn</xsl:if></td>
   <td width="100"><i>input</i></td>
   <td width="50"></td>   <td>
<p>gate from the UDP layer</p>
</td>
</tr>
<tr class="inherited">
   <td width="150">udpOut</xsl:if></td>
   <td width="100"><i>output</i></td>
   <td width="50"></td>   <td>
<p>gate to the UDP layer</p>
</td>
</tr>
<tr class="inherited">
   <td width="150">tcpIn</xsl:if></td>
   <td width="100"><i>input</i></td>
   <td width="50"></td>   <td>
<p>gate from the TCP layer</p>
</td>
</tr>
<tr class="inherited">
   <td width="150">tcpOut</xsl:if></td>
   <td width="100"><i>output</i></td>
   <td width="50"></td>   <td>
<p>gate to the TCP layer</p>
</td>
</tr>
<tr class="inherited">
   <td width="150">appIn</xsl:if></td>
   <td width="100"><i>input</i></td>
   <td width="50"></td>   <td>
<p>gate from the application</p>
</td>
</tr>
<tr class="inherited">
   <td width="150">appOut</xsl:if></td>
   <td width="100"><i>output</i></td>
   <td width="50"></td>   <td>
<p>gate to the application</p>
</td>
</tr>
<tr class="inherited">
   <td width="150">direct_in</xsl:if></td>
   <td width="100"><i>input</i></td>
   <td width="50"></td>   <td>
<p>gate for sendDirect</p>
</td>
</tr>
</table>
<h3 class="subtitle">Source code:</h3>
<pre class="src"><span style="color: #800000; font-weight: bold; ">simple</span><span style="color: #000000; "> </span><span style="color: #000000; ">Vast</span><span style="color: #000000; "> </span><span style="color: #800000; font-weight: bold; ">extends</span><span style="color: #000000; "> </span><span style="color: #000000; ">BaseOverlay</span><span style="color: #000000; ">
{
    </span><span style="color: #800000; font-weight: bold; ">parameters</span><span style="color: #000000; ">:
        </span><span style="color: #000000; font-weight: bold; ">@class</span><span style="color: #000000; ">(</span><span style="color: #000000; ">Vast</span><span style="color: #000000; ">);
        </span><span style="color: #000080; font-weight: bold; ">double</span><span style="color: #000000; "> </span><span style="color: #000000; ">areaDimension</span><span style="color: #000000; ">; </span><span style="color: #808080; font-style: italic; ">// movement range from [0.0, 0.0] to [areaDimension, areaDimension]
</span><span style="color: #000000; ">        </span><span style="color: #000080; font-weight: bold; ">bool</span><span style="color: #000000; "> </span><span style="color: #000000; ">debugVastOutput</span><span style="color: #000000; ">; </span><span style="color: #808080; font-style: italic; ">// enable voronoi diagram debug information
</span><span style="color: #000000; ">        </span><span style="color: #000080; font-weight: bold; ">double</span><span style="color: #000000; "> </span><span style="color: #000000; ">AOIWidth</span><span style="color: #000000; ">; </span><span style="color: #808080; font-style: italic; ">// this nodes area of interest
</span><span style="color: #000000; ">        </span><span style="color: #000080; font-weight: bold; ">double</span><span style="color: #000000; "> </span><span style="color: #000000; ">stockListSize</span><span style="color: #000000; ">; </span><span style="color: #808080; font-style: italic; ">// size of the stockList
</span><span style="color: #000000; ">        </span><span style="color: #000080; font-weight: bold; ">double</span><span style="color: #000000; "> </span><span style="color: #000000; ">joinTimeout</span><span style="color: #000000; "> </span><span style="color: #000000; font-weight: bold; ">@unit</span><span style="color: #000000; ">(</span><span style="color: #000000; ">s</span><span style="color: #000000; ">); </span><span style="color: #808080; font-style: italic; ">// retry join timeout in seconds
</span><span style="color: #000000; ">        </span><span style="color: #000080; font-weight: bold; ">double</span><span style="color: #000000; "> </span><span style="color: #000000; ">pingTimeout</span><span style="color: #000000; "> </span><span style="color: #000000; font-weight: bold; ">@unit</span><span style="color: #000000; ">(</span><span style="color: #000000; ">s</span><span style="color: #000000; ">); </span><span style="color: #808080; font-style: italic; ">// ping neighbor status in seconds
</span><span style="color: #000000; ">        </span><span style="color: #000080; font-weight: bold; ">double</span><span style="color: #000000; "> </span><span style="color: #000000; ">discoveryIntervall</span><span style="color: #000000; "> </span><span style="color: #000000; font-weight: bold; ">@unit</span><span style="color: #000000; ">(</span><span style="color: #000000; ">s</span><span style="color: #000000; ">); </span><span style="color: #808080; font-style: italic; ">// asks stock neighbors for their neighborslist
</span><span style="color: #000000; ">        </span><span style="color: #000080; font-weight: bold; ">double</span><span style="color: #000000; "> </span><span style="color: #000000; ">criticalCheckIntervall</span><span style="color: #000000; "> </span><span style="color: #000000; font-weight: bold; ">@unit</span><span style="color: #000000; ">(</span><span style="color: #000000; ">s</span><span style="color: #000000; ">); </span><span style="color: #808080; font-style: italic; ">// checks intervall for NeighborLevel for preventing partitions
</span><span style="color: #000000; ">        </span><span style="color: #000080; font-weight: bold; ">double</span><span style="color: #000000; "> </span><span style="color: #000000; ">criticalThreshold</span><span style="color: #000000; ">; </span><span style="color: #808080; font-style: italic; ">// threshold to activate backup operation
</span><span style="color: #000000; ">}

</span></pre>
   <hr><p class="footer"><a href="http://creativecommons.org/licenses/by-sa/3.0" target="_top"><img src="by-sa.png"></a> This documentation is released under the <a href="http://creativecommons.org/licenses/by-sa/3.0" target="_top">Creative Commons license</a></p>
   </body>
</html>
